cs-visual-time-papi

(0 reviews)

📘 Documentación de la API - CS Visual Time Papi

Esta sección describe los atributos y uso de la cs-visual-time-papi, versión 1. Permite la interacción segura con el proceso Visual Time para confirmar pagos de pólizas.

💂️ Información Base

Título de la API: cs-visual-time-papi
Versión: 1
URL Base: https://cs-visual-time-papi-{env}-v1.us-e1.cloudhub.io/api/
Entornos: dev, qa, prod

🔑 Autenticación

Encabezados Requeridos

Encabezado	Tipo	Descripción
Authorization	String	Token Bearer en el formato `Bearer {{API_KEY}}`
client_id	String	Identificador único para clientes de la API

> 📌 Estos encabezados son requeridos en todas las solicitudes.

✨ Endpoint: Confirmar Pago de Póliza

POST /portal-pagos/policy/payment/confirmation
- Descripción: Confirma el pago de una póliza enviada a través del Portal de Pagos.

Ejemplo del Cuerpo de Solicitud

{
  "policyId": "12345",
  "paymentDate": "2025-05-06",
  "amount": 150000
}

Ejemplo de Respuesta

{
  "status": "success",
  "message": "Policy payment confirmed successfully."
}

📎 Ver documentación completa: `documentation/post-portal-pagos-policy-payment-confirmation.md`

🔐 Esquemas de Seguridad

Aplicación de Client ID

Campo	Tipo	Requerido	Longitud	Regex
`client_id`	String	Sí	32 - 36	`[a-zA-Z0-9]`

OAuth 2.0

Campo	Tipo	Requerido	Longitud	Regex
`Authorization`	String	Sí	36 - 37	`[a-zA-Z0-9-_.]`

⚠️ Códigos de Error

Código	Descripción	Solución Sugerida
400	Solicitud Incorrecta	Verificar parámetros de consulta o cuerpo de solicitud.
401	No Autorizado	Verificar credenciales de autenticación.
404	No Encontrado	Recurso no encontrado.
500	Error Interno del Servidor	Reintentar o contactar soporte técnico.

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

Documentación actualizada por última vez: Septiembre 2025
Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma